PaymentInitiationAPI

DomesticPayments

createDomesticPaymentConsents

Create Domestic Payment Consents


/domestic-payment-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-payment-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomesticConsent4 body = ; // OBWriteDomesticConsent4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticConsentResponse5 result = apiInstance.createDomesticPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPaymentConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomesticConsent4 body = ; // OBWriteDomesticConsent4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticConsentResponse5 result = apiInstance.createDomesticPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticConsent4 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Create Domestic Payment Consents
[apiInstance createDomesticPaymentConsentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticConsentResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var body = ; // {{OBWriteDomesticConsent4}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticPaymentConsents(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticPaymentConsentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var body = new OBWriteDomesticConsent4(); // OBWriteDomesticConsent4 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create Domestic Payment Consents
                OBWriteDomesticConsentResponse5 result = apiInstance.createDomesticPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.createDomesticPaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$body = ; // OBWriteDomesticConsent4 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createDomesticPaymentConsents($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->createDomesticPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomesticConsent4->new(); # OBWriteDomesticConsent4 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createDomesticPaymentConsents(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->createDomesticPaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
body =  # OBWriteDomesticConsent4 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create Domestic Payment Consents
    api_response = api_instance.create_domestic_payment_consents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->createDomesticPaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - Domestic Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createDomesticPayments

Create Domestic Payments


/domestic-payments

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomestic2 body = ; // OBWriteDomestic2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticResponse5 result = apiInstance.createDomesticPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        OBWriteDomestic2 body = ; // OBWriteDomestic2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticResponse5 result = apiInstance.createDomesticPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#createDomesticPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomestic2 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Create Domestic Payments
[apiInstance createDomesticPaymentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var body = ; // {{OBWriteDomestic2}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticPayments(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticPaymentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var body = new OBWriteDomestic2(); // OBWriteDomestic2 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create Domestic Payments
                OBWriteDomesticResponse5 result = apiInstance.createDomesticPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.createDomesticPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$body = ; // OBWriteDomestic2 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createDomesticPayments($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->createDomesticPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomestic2->new(); # OBWriteDomestic2 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createDomesticPayments(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->createDomesticPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
body =  # OBWriteDomestic2 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create Domestic Payments
    api_response = api_instance.create_domestic_payments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->createDomesticPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - Domestic Payments Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticPaymentConsentsConsentId

Get Domestic Payment Consents


/domestic-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-payment-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticConsentResponse5 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticConsentResponse5 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Get Domestic Payment Consents
[apiInstance getDomesticPaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticConsentResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticPaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticPaymentConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Domestic Payment Consents
                OBWriteDomesticConsentResponse5 result = apiInstance.getDomesticPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.getDomesticPaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticPaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticPaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Domestic Payment Consents
    api_response = api_instance.get_domestic_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticPaymentConsentsConsentIdFundsConfirmation

Get Domestic Payment Consents Funds Confirmation


/domestic-payment-consents/{ConsentId}/funds-confirmation

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-payment-consents/{ConsentId}/funds-confirmation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Get Domestic Payment Consents Funds Confirmation
[apiInstance getDomesticPaymentConsentsConsentIdFundsConfirmationWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteFundsConfirmationResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticPaymentConsentsConsentIdFundsConfirmationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Domestic Payment Consents Funds Confirmation
                OBWriteFundsConfirmationResponse1 result = apiInstance.getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.getDomesticPaymentConsentsConsentIdFundsConfirmation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticPaymentConsentsConsentIdFundsConfirmation($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentIdFundsConfirmation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticPaymentConsentsConsentIdFundsConfirmation(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentIdFundsConfirmation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Domestic Payment Consents Funds Confirmation
    api_response = api_instance.get_domestic_payment_consents_consent_id_funds_confirmation(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->getDomesticPaymentConsentsConsentIdFundsConfirmation: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticPaymentsDomesticPaymentId

Get Domestic Payments


/domestic-payments/{DomesticPaymentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-payments/{DomesticPaymentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticResponse5 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentsDomesticPaymentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticPaymentsApi;

public class DomesticPaymentsApiExample {

    public static void main(String[] args) {
        DomesticPaymentsApi apiInstance = new DomesticPaymentsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticResponse5 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticPaymentsApi#getDomesticPaymentsDomesticPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *domesticPaymentId = domesticPaymentId_example; // DomesticPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticPaymentsApi *apiInstance = [[DomesticPaymentsApi alloc] init];

// Get Domestic Payments
[apiInstance getDomesticPaymentsDomesticPaymentIdWith:domesticPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticPaymentsApi()
var domesticPaymentId = domesticPaymentId_example; // {{String}} DomesticPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticPaymentsDomesticPaymentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticPaymentsApi();
            var domesticPaymentId = domesticPaymentId_example;  // String | DomesticPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Domestic Payments
                OBWriteDomesticResponse5 result = apiInstance.getDomesticPaymentsDomesticPaymentId(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticPaymentsApi.getDomesticPaymentsDomesticPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticPaymentsApi();
$domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticPaymentsDomesticPaymentId($domesticPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticPaymentsApi->getDomesticPaymentsDomesticPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticPaymentsApi->new();
my $domesticPaymentId = domesticPaymentId_example; # String | DomesticPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticPaymentsDomesticPaymentId(domesticPaymentId => $domesticPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticPaymentsApi->getDomesticPaymentsDomesticPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticPaymentsApi()
domesticPaymentId = domesticPaymentId_example # String | DomesticPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Domestic Payments
    api_response = api_instance.get_domestic_payments_domestic_payment_id(domesticPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticPaymentsApi->getDomesticPaymentsDomesticPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticPaymentId*
String
DomesticPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Payments Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

DomesticScheduledPayments

createDomesticScheduledPaymentConsents

Create Domestic Scheduled Payment Consents


/domestic-scheduled-payment-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-scheduled-payment-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduledConsent4 body = ; // OBWriteDomesticScheduledConsent4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticScheduledConsentResponse5 result = apiInstance.createDomesticScheduledPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduledConsent4 body = ; // OBWriteDomesticScheduledConsent4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticScheduledConsentResponse5 result = apiInstance.createDomesticScheduledPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticScheduledConsent4 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticScheduledPaymentsApi *apiInstance = [[DomesticScheduledPaymentsApi alloc] init];

// Create Domestic Scheduled Payment Consents
[apiInstance createDomesticScheduledPaymentConsentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledConsentResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()
var body = ; // {{OBWriteDomesticScheduledConsent4}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticScheduledPaymentConsents(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticScheduledPaymentConsentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var body = new OBWriteDomesticScheduledConsent4(); // OBWriteDomesticScheduledConsent4 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create Domestic Scheduled Payment Consents
                OBWriteDomesticScheduledConsentResponse5 result = apiInstance.createDomesticScheduledPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.createDomesticScheduledPaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticScheduledPaymentsApi();
$body = ; // OBWriteDomesticScheduledConsent4 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createDomesticScheduledPaymentConsents($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomesticScheduledConsent4->new(); # OBWriteDomesticScheduledConsent4 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createDomesticScheduledPaymentConsents(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
body =  # OBWriteDomesticScheduledConsent4 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create Domestic Scheduled Payment Consents
    api_response = api_instance.create_domestic_scheduled_payment_consents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - Domestic Scheduled Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createDomesticScheduledPayments

Create Domestic Scheduled Payments


/domestic-scheduled-payments

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-scheduled-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduled2 body = ; // OBWriteDomesticScheduled2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticScheduledResponse5 result = apiInstance.createDomesticScheduledPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        OBWriteDomesticScheduled2 body = ; // OBWriteDomesticScheduled2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticScheduledResponse5 result = apiInstance.createDomesticScheduledPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#createDomesticScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticScheduled2 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticScheduledPaymentsApi *apiInstance = [[DomesticScheduledPaymentsApi alloc] init];

// Create Domestic Scheduled Payments
[apiInstance createDomesticScheduledPaymentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()
var body = ; // {{OBWriteDomesticScheduled2}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticScheduledPayments(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticScheduledPaymentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var body = new OBWriteDomesticScheduled2(); // OBWriteDomesticScheduled2 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create Domestic Scheduled Payments
                OBWriteDomesticScheduledResponse5 result = apiInstance.createDomesticScheduledPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.createDomesticScheduledPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticScheduledPaymentsApi();
$body = ; // OBWriteDomesticScheduled2 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createDomesticScheduledPayments($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomesticScheduled2->new(); # OBWriteDomesticScheduled2 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createDomesticScheduledPayments(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
body =  # OBWriteDomesticScheduled2 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create Domestic Scheduled Payments
    api_response = api_instance.create_domestic_scheduled_payments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->createDomesticScheduledPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - Domestic Scheduled Payments Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticScheduledPaymentConsentsConsentId

Get Domestic Scheduled Payment Consents


/domestic-scheduled-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-scheduled-payment-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticScheduledConsentResponse5 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticScheduledConsentResponse5 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticScheduledPaymentsApi *apiInstance = [[DomesticScheduledPaymentsApi alloc] init];

// Get Domestic Scheduled Payment Consents
[apiInstance getDomesticScheduledPaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledConsentResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticScheduledPaymentConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Domestic Scheduled Payment Consents
                OBWriteDomesticScheduledConsentResponse5 result = apiInstance.getDomesticScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.getDomesticScheduledPaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticScheduledPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticScheduledPaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticScheduledPaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Domestic Scheduled Payment Consents
    api_response = api_instance.get_domestic_scheduled_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Scheduled Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticScheduledPaymentsDomesticScheduledPaymentId

Get Domestic Scheduled Payments


/domestic-scheduled-payments/{DomesticScheduledPaymentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-scheduled-payments/{DomesticScheduledPaymentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticScheduledResponse5 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticScheduledPaymentsApi;

public class DomesticScheduledPaymentsApiExample {

    public static void main(String[] args) {
        DomesticScheduledPaymentsApi apiInstance = new DomesticScheduledPaymentsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticScheduledResponse5 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticScheduledPaymentsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *domesticScheduledPaymentId = domesticScheduledPaymentId_example; // DomesticScheduledPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticScheduledPaymentsApi *apiInstance = [[DomesticScheduledPaymentsApi alloc] init];

// Get Domestic Scheduled Payments
[apiInstance getDomesticScheduledPaymentsDomesticScheduledPaymentIdWith:domesticScheduledPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticScheduledResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticScheduledPaymentsApi()
var domesticScheduledPaymentId = domesticScheduledPaymentId_example; // {{String}} DomesticScheduledPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticScheduledPaymentsDomesticScheduledPaymentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticScheduledPaymentsApi();
            var domesticScheduledPaymentId = domesticScheduledPaymentId_example;  // String | DomesticScheduledPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Domestic Scheduled Payments
                OBWriteDomesticScheduledResponse5 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticScheduledPaymentsApi.getDomesticScheduledPaymentsDomesticScheduledPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticScheduledPaymentsApi();
$domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticScheduledPaymentsDomesticScheduledPaymentId($domesticScheduledPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticScheduledPaymentsApi->new();
my $domesticScheduledPaymentId = domesticScheduledPaymentId_example; # String | DomesticScheduledPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticScheduledPaymentsDomesticScheduledPaymentId(domesticScheduledPaymentId => $domesticScheduledPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticScheduledPaymentsApi()
domesticScheduledPaymentId = domesticScheduledPaymentId_example # String | DomesticScheduledPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Domestic Scheduled Payments
    api_response = api_instance.get_domestic_scheduled_payments_domestic_scheduled_payment_id(domesticScheduledPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticScheduledPaymentsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticScheduledPaymentId*
String
DomesticScheduledPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

DomesticStandingOrders

createDomesticStandingOrderConsents

Create Domestic Standing Order Consents


/domestic-standing-order-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-standing-order-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticStandingOrdersApi;

import java.io.File;
import java.util.*;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrderConsent5 body = ; // OBWriteDomesticStandingOrderConsent5 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticStandingOrderConsentResponse6 result = apiInstance.createDomesticStandingOrderConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrderConsent5 body = ; // OBWriteDomesticStandingOrderConsent5 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticStandingOrderConsentResponse6 result = apiInstance.createDomesticStandingOrderConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticStandingOrderConsent5 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticStandingOrdersApi *apiInstance = [[DomesticStandingOrdersApi alloc] init];

// Create Domestic Standing Order Consents
[apiInstance createDomesticStandingOrderConsentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderConsentResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()
var body = ; // {{OBWriteDomesticStandingOrderConsent5}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticStandingOrderConsents(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticStandingOrderConsentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var body = new OBWriteDomesticStandingOrderConsent5(); // OBWriteDomesticStandingOrderConsent5 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create Domestic Standing Order Consents
                OBWriteDomesticStandingOrderConsentResponse6 result = apiInstance.createDomesticStandingOrderConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.createDomesticStandingOrderConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticStandingOrdersApi();
$body = ; // OBWriteDomesticStandingOrderConsent5 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createDomesticStandingOrderConsents($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrderConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomesticStandingOrderConsent5->new(); # OBWriteDomesticStandingOrderConsent5 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createDomesticStandingOrderConsents(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrderConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticStandingOrdersApi()
body =  # OBWriteDomesticStandingOrderConsent5 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create Domestic Standing Order Consents
    api_response = api_instance.create_domestic_standing_order_consents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrderConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - Domestic Standing Order Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createDomesticStandingOrders

Create Domestic Standing Orders


/domestic-standing-orders

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-standing-orders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticStandingOrdersApi;

import java.io.File;
import java.util.*;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrder3 body = ; // OBWriteDomesticStandingOrder3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticStandingOrderResponse6 result = apiInstance.createDomesticStandingOrders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        OBWriteDomesticStandingOrder3 body = ; // OBWriteDomesticStandingOrder3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticStandingOrderResponse6 result = apiInstance.createDomesticStandingOrders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#createDomesticStandingOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteDomesticStandingOrder3 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticStandingOrdersApi *apiInstance = [[DomesticStandingOrdersApi alloc] init];

// Create Domestic Standing Orders
[apiInstance createDomesticStandingOrdersWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()
var body = ; // {{OBWriteDomesticStandingOrder3}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createDomesticStandingOrders(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createDomesticStandingOrdersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var body = new OBWriteDomesticStandingOrder3(); // OBWriteDomesticStandingOrder3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create Domestic Standing Orders
                OBWriteDomesticStandingOrderResponse6 result = apiInstance.createDomesticStandingOrders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.createDomesticStandingOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticStandingOrdersApi();
$body = ; // OBWriteDomesticStandingOrder3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createDomesticStandingOrders($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteDomesticStandingOrder3->new(); # OBWriteDomesticStandingOrder3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createDomesticStandingOrders(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticStandingOrdersApi()
body =  # OBWriteDomesticStandingOrder3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create Domestic Standing Orders
    api_response = api_instance.create_domestic_standing_orders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->createDomesticStandingOrders: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - Domestic Standing Orders Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticStandingOrderConsentsConsentId

Get Domestic Standing Order Consents


/domestic-standing-order-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-standing-order-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticStandingOrdersApi;

import java.io.File;
import java.util.*;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticStandingOrderConsentResponse6 result = apiInstance.getDomesticStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrderConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticStandingOrderConsentResponse6 result = apiInstance.getDomesticStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrderConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticStandingOrdersApi *apiInstance = [[DomesticStandingOrdersApi alloc] init];

// Get Domestic Standing Order Consents
[apiInstance getDomesticStandingOrderConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderConsentResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticStandingOrderConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticStandingOrderConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Domestic Standing Order Consents
                OBWriteDomesticStandingOrderConsentResponse6 result = apiInstance.getDomesticStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.getDomesticStandingOrderConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticStandingOrdersApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticStandingOrderConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrderConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticStandingOrderConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrderConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticStandingOrdersApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Domestic Standing Order Consents
    api_response = api_instance.get_domestic_standing_order_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrderConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Standing Order Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticStandingOrdersDomesticStandingOrderId

Get Domestic Standing Orders


/domestic-standing-orders/{DomesticStandingOrderId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-standing-orders/{DomesticStandingOrderId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DomesticStandingOrdersApi;

import java.io.File;
import java.util.*;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticStandingOrderResponse6 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrdersDomesticStandingOrderId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DomesticStandingOrdersApi;

public class DomesticStandingOrdersApiExample {

    public static void main(String[] args) {
        DomesticStandingOrdersApi apiInstance = new DomesticStandingOrdersApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteDomesticStandingOrderResponse6 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DomesticStandingOrdersApi#getDomesticStandingOrdersDomesticStandingOrderId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *domesticStandingOrderId = domesticStandingOrderId_example; // DomesticStandingOrderId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

DomesticStandingOrdersApi *apiInstance = [[DomesticStandingOrdersApi alloc] init];

// Get Domestic Standing Orders
[apiInstance getDomesticStandingOrdersDomesticStandingOrderIdWith:domesticStandingOrderId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteDomesticStandingOrderResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.DomesticStandingOrdersApi()
var domesticStandingOrderId = domesticStandingOrderId_example; // {{String}} DomesticStandingOrderId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticStandingOrdersDomesticStandingOrderIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new DomesticStandingOrdersApi();
            var domesticStandingOrderId = domesticStandingOrderId_example;  // String | DomesticStandingOrderId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Domestic Standing Orders
                OBWriteDomesticStandingOrderResponse6 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DomesticStandingOrdersApi.getDomesticStandingOrdersDomesticStandingOrderId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiDomesticStandingOrdersApi();
$domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticStandingOrdersDomesticStandingOrderId($domesticStandingOrderId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrdersDomesticStandingOrderId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DomesticStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::DomesticStandingOrdersApi->new();
my $domesticStandingOrderId = domesticStandingOrderId_example; # String | DomesticStandingOrderId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticStandingOrdersDomesticStandingOrderId(domesticStandingOrderId => $domesticStandingOrderId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrdersDomesticStandingOrderId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.DomesticStandingOrdersApi()
domesticStandingOrderId = domesticStandingOrderId_example # String | DomesticStandingOrderId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Domestic Standing Orders
    api_response = api_instance.get_domestic_standing_orders_domestic_standing_order_id(domesticStandingOrderId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DomesticStandingOrdersApi->getDomesticStandingOrdersDomesticStandingOrderId: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticStandingOrderId*
String
DomesticStandingOrderId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Domestic Standing Orders Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

FilePayments

createFilePaymentConsents

Create File Payment Consents


/file-payment-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/file-payment-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        OBWriteFileConsent3 body = ; // OBWriteFileConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFileConsentResponse4 result = apiInstance.createFilePaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePaymentConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        OBWriteFileConsent3 body = ; // OBWriteFileConsent3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFileConsentResponse4 result = apiInstance.createFilePaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteFileConsent3 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Create File Payment Consents
[apiInstance createFilePaymentConsentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteFileConsentResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.FilePaymentsApi()
var body = ; // {{OBWriteFileConsent3}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFilePaymentConsents(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFilePaymentConsentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var body = new OBWriteFileConsent3(); // OBWriteFileConsent3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create File Payment Consents
                OBWriteFileConsentResponse4 result = apiInstance.createFilePaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.createFilePaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFilePaymentsApi();
$body = ; // OBWriteFileConsent3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createFilePaymentConsents($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->createFilePaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteFileConsent3->new(); # OBWriteFileConsent3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createFilePaymentConsents(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->createFilePaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
body =  # OBWriteFileConsent3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create File Payment Consents
    api_response = api_instance.create_file_payment_consents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->createFilePaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - File Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createFilePaymentConsentsConsentIdFile

Create File Payment Consents


/file-payment-consents/{ConsentId}/file

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: */*"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/file-payment-consents/{ConsentId}/file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        File body = ; // File | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String consentId = consentId_example; // String | ConsentId
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            apiInstance.createFilePaymentConsentsConsentIdFile(body, authorization, xIdempotencyKey, xJwsSignature, consentId, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePaymentConsentsConsentIdFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        File body = ; // File | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String consentId = consentId_example; // String | ConsentId
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            apiInstance.createFilePaymentConsentsConsentIdFile(body, authorization, xIdempotencyKey, xJwsSignature, consentId, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePaymentConsentsConsentIdFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
File *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *consentId = consentId_example; // ConsentId
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Create File Payment Consents
[apiInstance createFilePaymentConsentsConsentIdFileWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    consentId:consentId
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.FilePaymentsApi()
var body = ; // {{File}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var consentId = consentId_example; // {{String}} ConsentId
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createFilePaymentConsentsConsentIdFile(bodyauthorizationxIdempotencyKeyxJwsSignatureconsentId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFilePaymentConsentsConsentIdFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var body = new File(); // File | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var consentId = consentId_example;  // String | ConsentId
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create File Payment Consents
                apiInstance.createFilePaymentConsentsConsentIdFile(body, authorization, xIdempotencyKey, xJwsSignature, consentId, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.createFilePaymentConsentsConsentIdFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFilePaymentsApi();
$body = ; // File | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$consentId = consentId_example; // String | ConsentId
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $api_instance->createFilePaymentConsentsConsentIdFile($body, $authorization, $xIdempotencyKey, $xJwsSignature, $consentId, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->createFilePaymentConsentsConsentIdFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $body = WWW::SwaggerClient::Object::File->new(); # File | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $consentId = consentId_example; # String | ConsentId
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    $api_instance->createFilePaymentConsentsConsentIdFile(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, consentId => $consentId, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->createFilePaymentConsentsConsentIdFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
body =  # File | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
consentId = consentId_example # String | ConsentId
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create File Payment Consents
    api_instance.create_file_payment_consents_consent_id_file(body, authorization, xIdempotencyKey, xJwsSignature, consentId, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->createFilePaymentConsentsConsentIdFile: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 200 - File Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createFilePayments

Create File Payments


/file-payments

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/file-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        OBWriteFile2 body = ; // OBWriteFile2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFileResponse3 result = apiInstance.createFilePayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        OBWriteFile2 body = ; // OBWriteFile2 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFileResponse3 result = apiInstance.createFilePayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#createFilePayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteFile2 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Create File Payments
[apiInstance createFilePaymentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteFileResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.FilePaymentsApi()
var body = ; // {{OBWriteFile2}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createFilePayments(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFilePaymentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var body = new OBWriteFile2(); // OBWriteFile2 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create File Payments
                OBWriteFileResponse3 result = apiInstance.createFilePayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.createFilePayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFilePaymentsApi();
$body = ; // OBWriteFile2 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createFilePayments($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->createFilePayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteFile2->new(); # OBWriteFile2 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createFilePayments(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->createFilePayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
body =  # OBWriteFile2 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create File Payments
    api_response = api_instance.create_file_payments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->createFilePayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - File Payments Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getFilePaymentConsentsConsentId

Get File Payment Consents


/file-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/file-payment-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFileConsentResponse4 result = apiInstance.getFilePaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFileConsentResponse4 result = apiInstance.getFilePaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Get File Payment Consents
[apiInstance getFilePaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteFileConsentResponse4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.FilePaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get File Payment Consents
                OBWriteFileConsentResponse4 result = apiInstance.getFilePaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.getFilePaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFilePaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getFilePaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getFilePaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get File Payment Consents
    api_response = api_instance.get_file_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - File Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getFilePaymentConsentsConsentIdFile

Get File Payment Consents


/file-payment-consents/{ConsentId}/file

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: */*,text/xml,application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/file-payment-consents/{ConsentId}/file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            File result = apiInstance.getFilePaymentConsentsConsentIdFile(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentConsentsConsentIdFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            File result = apiInstance.getFilePaymentConsentsConsentIdFile(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentConsentsConsentIdFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Get File Payment Consents
[apiInstance getFilePaymentConsentsConsentIdFileWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.FilePaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentConsentsConsentIdFile(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentConsentsConsentIdFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get File Payment Consents
                File result = apiInstance.getFilePaymentConsentsConsentIdFile(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.getFilePaymentConsentsConsentIdFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFilePaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getFilePaymentConsentsConsentIdFile($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentIdFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getFilePaymentConsentsConsentIdFile(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentIdFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get File Payment Consents
    api_response = api_instance.get_file_payment_consents_consent_id_file(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->getFilePaymentConsentsConsentIdFile: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - File Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getFilePaymentsFilePaymentId

Get File Payments


/file-payments/{FilePaymentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/file-payments/{FilePaymentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFileResponse3 result = apiInstance.getFilePaymentsFilePaymentId(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentsFilePaymentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFileResponse3 result = apiInstance.getFilePaymentsFilePaymentId(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentsFilePaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *filePaymentId = filePaymentId_example; // FilePaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Get File Payments
[apiInstance getFilePaymentsFilePaymentIdWith:filePaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteFileResponse3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.FilePaymentsApi()
var filePaymentId = filePaymentId_example; // {{String}} FilePaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentsFilePaymentId(filePaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentsFilePaymentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var filePaymentId = filePaymentId_example;  // String | FilePaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get File Payments
                OBWriteFileResponse3 result = apiInstance.getFilePaymentsFilePaymentId(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.getFilePaymentsFilePaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFilePaymentsApi();
$filePaymentId = filePaymentId_example; // String | FilePaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getFilePaymentsFilePaymentId($filePaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $filePaymentId = filePaymentId_example; # String | FilePaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getFilePaymentsFilePaymentId(filePaymentId => $filePaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
filePaymentId = filePaymentId_example # String | FilePaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get File Payments
    api_response = api_instance.get_file_payments_file_payment_id(filePaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
FilePaymentId*
String
FilePaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - File Payments Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getFilePaymentsFilePaymentIdReportFile

Get File Payments


/file-payments/{FilePaymentId}/report-file

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: */*,text/xml,application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/file-payments/{FilePaymentId}/report-file"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FilePaymentsApi;

import java.io.File;
import java.util.*;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            File result = apiInstance.getFilePaymentsFilePaymentIdReportFile(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentsFilePaymentIdReportFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FilePaymentsApi;

public class FilePaymentsApiExample {

    public static void main(String[] args) {
        FilePaymentsApi apiInstance = new FilePaymentsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            File result = apiInstance.getFilePaymentsFilePaymentIdReportFile(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FilePaymentsApi#getFilePaymentsFilePaymentIdReportFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *filePaymentId = filePaymentId_example; // FilePaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

FilePaymentsApi *apiInstance = [[FilePaymentsApi alloc] init];

// Get File Payments
[apiInstance getFilePaymentsFilePaymentIdReportFileWith:filePaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(File output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.FilePaymentsApi()
var filePaymentId = filePaymentId_example; // {{String}} FilePaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentsFilePaymentIdReportFile(filePaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentsFilePaymentIdReportFileExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new FilePaymentsApi();
            var filePaymentId = filePaymentId_example;  // String | FilePaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get File Payments
                File result = apiInstance.getFilePaymentsFilePaymentIdReportFile(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FilePaymentsApi.getFilePaymentsFilePaymentIdReportFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiFilePaymentsApi();
$filePaymentId = filePaymentId_example; // String | FilePaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getFilePaymentsFilePaymentIdReportFile($filePaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentIdReportFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FilePaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::FilePaymentsApi->new();
my $filePaymentId = filePaymentId_example; # String | FilePaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getFilePaymentsFilePaymentIdReportFile(filePaymentId => $filePaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentIdReportFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.FilePaymentsApi()
filePaymentId = filePaymentId_example # String | FilePaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get File Payments
    api_response = api_instance.get_file_payments_file_payment_id_report_file(filePaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FilePaymentsApi->getFilePaymentsFilePaymentIdReportFile: %s\n" % e)

Parameters

Path parameters
Name Description
FilePaymentId*
String
FilePaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - File Payments Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

InternationalPayments

createInternationalPaymentConsents

Create International Payment Consents


/international-payment-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-payment-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        OBWriteInternationalConsent5 body = ; // OBWriteInternationalConsent5 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalConsentResponse6 result = apiInstance.createInternationalPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#createInternationalPaymentConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        OBWriteInternationalConsent5 body = ; // OBWriteInternationalConsent5 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalConsentResponse6 result = apiInstance.createInternationalPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#createInternationalPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteInternationalConsent5 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Create International Payment Consents
[apiInstance createInternationalPaymentConsentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalConsentResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalPaymentsApi()
var body = ; // {{OBWriteInternationalConsent5}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalPaymentConsents(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalPaymentConsentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var body = new OBWriteInternationalConsent5(); // OBWriteInternationalConsent5 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create International Payment Consents
                OBWriteInternationalConsentResponse6 result = apiInstance.createInternationalPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.createInternationalPaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalPaymentsApi();
$body = ; // OBWriteInternationalConsent5 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createInternationalPaymentConsents($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->createInternationalPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteInternationalConsent5->new(); # OBWriteInternationalConsent5 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createInternationalPaymentConsents(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->createInternationalPaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
body =  # OBWriteInternationalConsent5 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create International Payment Consents
    api_response = api_instance.create_international_payment_consents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->createInternationalPaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - International Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createInternationalPayments

Create International Payments


/international-payments

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        OBWriteInternational3 body = ; // OBWriteInternational3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalResponse5 result = apiInstance.createInternationalPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#createInternationalPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        OBWriteInternational3 body = ; // OBWriteInternational3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalResponse5 result = apiInstance.createInternationalPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#createInternationalPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteInternational3 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Create International Payments
[apiInstance createInternationalPaymentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalPaymentsApi()
var body = ; // {{OBWriteInternational3}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalPayments(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalPaymentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var body = new OBWriteInternational3(); // OBWriteInternational3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create International Payments
                OBWriteInternationalResponse5 result = apiInstance.createInternationalPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.createInternationalPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalPaymentsApi();
$body = ; // OBWriteInternational3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createInternationalPayments($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->createInternationalPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteInternational3->new(); # OBWriteInternational3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createInternationalPayments(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->createInternationalPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
body =  # OBWriteInternational3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create International Payments
    api_response = api_instance.create_international_payments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->createInternationalPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - International Payments Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalPaymentConsentsConsentId

Get International Payment Consents


/international-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-payment-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalConsentResponse6 result = apiInstance.getInternationalPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalConsentResponse6 result = apiInstance.getInternationalPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Get International Payment Consents
[apiInstance getInternationalPaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalConsentResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalPaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalPaymentConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get International Payment Consents
                OBWriteInternationalConsentResponse6 result = apiInstance.getInternationalPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.getInternationalPaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalPaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalPaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get International Payment Consents
    api_response = api_instance.get_international_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - International Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalPaymentConsentsConsentIdFundsConfirmation

Get International Payment Consents Funds Confirmation


/international-payment-consents/{ConsentId}/funds-confirmation

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-payment-consents/{ConsentId}/funds-confirmation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Get International Payment Consents Funds Confirmation
[apiInstance getInternationalPaymentConsentsConsentIdFundsConfirmationWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteFundsConfirmationResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalPaymentConsentsConsentIdFundsConfirmationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get International Payment Consents Funds Confirmation
                OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.getInternationalPaymentConsentsConsentIdFundsConfirmation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalPaymentConsentsConsentIdFundsConfirmation($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentIdFundsConfirmation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalPaymentConsentsConsentIdFundsConfirmation(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentIdFundsConfirmation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get International Payment Consents Funds Confirmation
    api_response = api_instance.get_international_payment_consents_consent_id_funds_confirmation(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->getInternationalPaymentConsentsConsentIdFundsConfirmation: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - International Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalPaymentsInternationalPaymentId

Get International Payments


/international-payments/{InternationalPaymentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-payments/{InternationalPaymentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalResponse5 result = apiInstance.getInternationalPaymentsInternationalPaymentId(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentsInternationalPaymentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalPaymentsApi;

public class InternationalPaymentsApiExample {

    public static void main(String[] args) {
        InternationalPaymentsApi apiInstance = new InternationalPaymentsApi();
        String internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalResponse5 result = apiInstance.getInternationalPaymentsInternationalPaymentId(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalPaymentsApi#getInternationalPaymentsInternationalPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *internationalPaymentId = internationalPaymentId_example; // InternationalPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalPaymentsApi *apiInstance = [[InternationalPaymentsApi alloc] init];

// Get International Payments
[apiInstance getInternationalPaymentsInternationalPaymentIdWith:internationalPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalResponse5 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalPaymentsApi()
var internationalPaymentId = internationalPaymentId_example; // {{String}} InternationalPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalPaymentsInternationalPaymentId(internationalPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalPaymentsInternationalPaymentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalPaymentsApi();
            var internationalPaymentId = internationalPaymentId_example;  // String | InternationalPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get International Payments
                OBWriteInternationalResponse5 result = apiInstance.getInternationalPaymentsInternationalPaymentId(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalPaymentsApi.getInternationalPaymentsInternationalPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalPaymentsApi();
$internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalPaymentsInternationalPaymentId($internationalPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalPaymentsApi->getInternationalPaymentsInternationalPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalPaymentsApi->new();
my $internationalPaymentId = internationalPaymentId_example; # String | InternationalPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalPaymentsInternationalPaymentId(internationalPaymentId => $internationalPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalPaymentsApi->getInternationalPaymentsInternationalPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalPaymentsApi()
internationalPaymentId = internationalPaymentId_example # String | InternationalPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get International Payments
    api_response = api_instance.get_international_payments_international_payment_id(internationalPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalPaymentsApi->getInternationalPaymentsInternationalPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalPaymentId*
String
InternationalPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - International Payments Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

InternationalScheduledPayments

createInternationalScheduledPaymentConsents

Create International Scheduled Payment Consents


/international-scheduled-payment-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-scheduled-payment-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        OBWriteInternationalScheduledConsent5 body = ; // OBWriteInternationalScheduledConsent5 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalScheduledConsentResponse6 result = apiInstance.createInternationalScheduledPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#createInternationalScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        OBWriteInternationalScheduledConsent5 body = ; // OBWriteInternationalScheduledConsent5 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalScheduledConsentResponse6 result = apiInstance.createInternationalScheduledPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#createInternationalScheduledPaymentConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteInternationalScheduledConsent5 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Create International Scheduled Payment Consents
[apiInstance createInternationalScheduledPaymentConsentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalScheduledConsentResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalScheduledPaymentsApi()
var body = ; // {{OBWriteInternationalScheduledConsent5}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalScheduledPaymentConsents(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalScheduledPaymentConsentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var body = new OBWriteInternationalScheduledConsent5(); // OBWriteInternationalScheduledConsent5 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create International Scheduled Payment Consents
                OBWriteInternationalScheduledConsentResponse6 result = apiInstance.createInternationalScheduledPaymentConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.createInternationalScheduledPaymentConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalScheduledPaymentsApi();
$body = ; // OBWriteInternationalScheduledConsent5 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createInternationalScheduledPaymentConsents($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPaymentConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteInternationalScheduledConsent5->new(); # OBWriteInternationalScheduledConsent5 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createInternationalScheduledPaymentConsents(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPaymentConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
body =  # OBWriteInternationalScheduledConsent5 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create International Scheduled Payment Consents
    api_response = api_instance.create_international_scheduled_payment_consents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPaymentConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - International Scheduled Payment Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createInternationalScheduledPayments

Create International Scheduled Payments


/international-scheduled-payments

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-scheduled-payments"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        OBWriteInternationalScheduled3 body = ; // OBWriteInternationalScheduled3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalScheduledResponse6 result = apiInstance.createInternationalScheduledPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#createInternationalScheduledPayments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        OBWriteInternationalScheduled3 body = ; // OBWriteInternationalScheduled3 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalScheduledResponse6 result = apiInstance.createInternationalScheduledPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#createInternationalScheduledPayments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteInternationalScheduled3 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Create International Scheduled Payments
[apiInstance createInternationalScheduledPaymentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalScheduledResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalScheduledPaymentsApi()
var body = ; // {{OBWriteInternationalScheduled3}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalScheduledPayments(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalScheduledPaymentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var body = new OBWriteInternationalScheduled3(); // OBWriteInternationalScheduled3 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create International Scheduled Payments
                OBWriteInternationalScheduledResponse6 result = apiInstance.createInternationalScheduledPayments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.createInternationalScheduledPayments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalScheduledPaymentsApi();
$body = ; // OBWriteInternationalScheduled3 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createInternationalScheduledPayments($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPayments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteInternationalScheduled3->new(); # OBWriteInternationalScheduled3 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createInternationalScheduledPayments(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPayments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
body =  # OBWriteInternationalScheduled3 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create International Scheduled Payments
    api_response = api_instance.create_international_scheduled_payments(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->createInternationalScheduledPayments: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - International Scheduled Payments Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalScheduledPaymentConsentsConsentId

Get International Scheduled Payment Consents


/international-scheduled-payment-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-scheduled-payment-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalScheduledConsentResponse6 result = apiInstance.getInternationalScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalScheduledConsentResponse6 result = apiInstance.getInternationalScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Get International Scheduled Payment Consents
[apiInstance getInternationalScheduledPaymentConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalScheduledConsentResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalScheduledPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalScheduledPaymentConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalScheduledPaymentConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get International Scheduled Payment Consents
                OBWriteInternationalScheduledConsentResponse6 result = apiInstance.getInternationalScheduledPaymentConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.getInternationalScheduledPaymentConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalScheduledPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalScheduledPaymentConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalScheduledPaymentConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get International Scheduled Payment Consents
    api_response = api_instance.get_international_scheduled_payment_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - International Scheduled Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation

Get International Scheduled Payment Consents Funds Confirmation


/international-scheduled-payment-consents/{ConsentId}/funds-confirmation

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-scheduled-payment-consents/{ConsentId}/funds-confirmation"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Get International Scheduled Payment Consents Funds Confirmation
[apiInstance getInternationalScheduledPaymentConsentsConsentIdFundsConfirmationWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteFundsConfirmationResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalScheduledPaymentsApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalScheduledPaymentConsentsConsentIdFundsConfirmationExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get International Scheduled Payment Consents Funds Confirmation
                OBWriteFundsConfirmationResponse1 result = apiInstance.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalScheduledPaymentsApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get International Scheduled Payment Consents Funds Confirmation
    api_response = api_instance.get_international_scheduled_payment_consents_consent_id_funds_confirmation(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentConsentsConsentIdFundsConfirmation: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - International Scheduled Payment Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalScheduledPaymentsInternationalScheduledPaymentId

Get International Scheduled Payments


/international-scheduled-payments/{InternationalScheduledPaymentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-scheduled-payments/{InternationalScheduledPaymentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalScheduledPaymentsApi;

import java.io.File;
import java.util.*;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalScheduledResponse6 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentsInternationalScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalScheduledPaymentsApi;

public class InternationalScheduledPaymentsApiExample {

    public static void main(String[] args) {
        InternationalScheduledPaymentsApi apiInstance = new InternationalScheduledPaymentsApi();
        String internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalScheduledResponse6 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalScheduledPaymentsApi#getInternationalScheduledPaymentsInternationalScheduledPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *internationalScheduledPaymentId = internationalScheduledPaymentId_example; // InternationalScheduledPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalScheduledPaymentsApi *apiInstance = [[InternationalScheduledPaymentsApi alloc] init];

// Get International Scheduled Payments
[apiInstance getInternationalScheduledPaymentsInternationalScheduledPaymentIdWith:internationalScheduledPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalScheduledResponse6 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalScheduledPaymentsApi()
var internationalScheduledPaymentId = internationalScheduledPaymentId_example; // {{String}} InternationalScheduledPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalScheduledPaymentsInternationalScheduledPaymentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalScheduledPaymentsApi();
            var internationalScheduledPaymentId = internationalScheduledPaymentId_example;  // String | InternationalScheduledPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get International Scheduled Payments
                OBWriteInternationalScheduledResponse6 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalScheduledPaymentsApi.getInternationalScheduledPaymentsInternationalScheduledPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalScheduledPaymentsApi();
$internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalScheduledPaymentsInternationalScheduledPaymentId($internationalScheduledPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalScheduledPaymentsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalScheduledPaymentsApi->new();
my $internationalScheduledPaymentId = internationalScheduledPaymentId_example; # String | InternationalScheduledPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalScheduledPaymentsInternationalScheduledPaymentId(internationalScheduledPaymentId => $internationalScheduledPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalScheduledPaymentsApi()
internationalScheduledPaymentId = internationalScheduledPaymentId_example # String | InternationalScheduledPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get International Scheduled Payments
    api_response = api_instance.get_international_scheduled_payments_international_scheduled_payment_id(internationalScheduledPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalScheduledPaymentsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalScheduledPaymentId*
String
InternationalScheduledPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - International Scheduled Payments Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

InternationalStandingOrders

createInternationalStandingOrderConsents

Create International Standing Order Consents


/international-standing-order-consents

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-standing-order-consents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalStandingOrdersApi;

import java.io.File;
import java.util.*;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        OBWriteInternationalStandingOrderConsent6 body = ; // OBWriteInternationalStandingOrderConsent6 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalStandingOrderConsentResponse7 result = apiInstance.createInternationalStandingOrderConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#createInternationalStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalStandingOrdersApi;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        OBWriteInternationalStandingOrderConsent6 body = ; // OBWriteInternationalStandingOrderConsent6 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalStandingOrderConsentResponse7 result = apiInstance.createInternationalStandingOrderConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#createInternationalStandingOrderConsents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteInternationalStandingOrderConsent6 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalStandingOrdersApi *apiInstance = [[InternationalStandingOrdersApi alloc] init];

// Create International Standing Order Consents
[apiInstance createInternationalStandingOrderConsentsWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalStandingOrderConsentResponse7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalStandingOrdersApi()
var body = ; // {{OBWriteInternationalStandingOrderConsent6}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalStandingOrderConsents(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalStandingOrderConsentsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalStandingOrdersApi();
            var body = new OBWriteInternationalStandingOrderConsent6(); // OBWriteInternationalStandingOrderConsent6 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create International Standing Order Consents
                OBWriteInternationalStandingOrderConsentResponse7 result = apiInstance.createInternationalStandingOrderConsents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalStandingOrdersApi.createInternationalStandingOrderConsents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalStandingOrdersApi();
$body = ; // OBWriteInternationalStandingOrderConsent6 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createInternationalStandingOrderConsents($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrderConsents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalStandingOrdersApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteInternationalStandingOrderConsent6->new(); # OBWriteInternationalStandingOrderConsent6 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createInternationalStandingOrderConsents(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrderConsents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalStandingOrdersApi()
body =  # OBWriteInternationalStandingOrderConsent6 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create International Standing Order Consents
    api_response = api_instance.create_international_standing_order_consents(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrderConsents: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - International Standing Order Consents Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

createInternationalStandingOrders

Create International Standing Orders


/international-standing-orders

Usage and SDK Samples

curl -X POST\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
-H "Content-Type: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-standing-orders"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalStandingOrdersApi;

import java.io.File;
import java.util.*;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: PSUOAuth2Security
        OAuth PSUOAuth2Security = (OAuth) defaultClient.getAuthentication("PSUOAuth2Security");
        PSUOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        OBWriteInternationalStandingOrder4 body = ; // OBWriteInternationalStandingOrder4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalStandingOrderResponse7 result = apiInstance.createInternationalStandingOrders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#createInternationalStandingOrders");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalStandingOrdersApi;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        OBWriteInternationalStandingOrder4 body = ; // OBWriteInternationalStandingOrder4 | Default
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

        String xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalStandingOrderResponse7 result = apiInstance.createInternationalStandingOrders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#createInternationalStandingOrders");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: PSUOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
OBWriteInternationalStandingOrder4 *body = ; // Default
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xIdempotencyKey = xIdempotencyKey_example; // Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

String *xJwsSignature = xJwsSignature_example; // A detached JWS signature of the body of the payload.
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalStandingOrdersApi *apiInstance = [[InternationalStandingOrdersApi alloc] init];

// Create International Standing Orders
[apiInstance createInternationalStandingOrdersWith:body
    authorization:authorization
    xIdempotencyKey:xIdempotencyKey
    xJwsSignature:xJwsSignature
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalStandingOrderResponse7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: PSUOAuth2Security
var PSUOAuth2Security = defaultClient.authentications['PSUOAuth2Security'];
PSUOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalStandingOrdersApi()
var body = ; // {{OBWriteInternationalStandingOrder4}} Default
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var xIdempotencyKey = xIdempotencyKey_example; // {{String}} Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

var xJwsSignature = xJwsSignature_example; // {{String}} A detached JWS signature of the body of the payload.
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInternationalStandingOrders(bodyauthorizationxIdempotencyKeyxJwsSignature, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInternationalStandingOrdersExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: PSUOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalStandingOrdersApi();
            var body = new OBWriteInternationalStandingOrder4(); // OBWriteInternationalStandingOrder4 | Default
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xIdempotencyKey = xIdempotencyKey_example;  // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

            var xJwsSignature = xJwsSignature_example;  // String | A detached JWS signature of the body of the payload.
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Create International Standing Orders
                OBWriteInternationalStandingOrderResponse7 result = apiInstance.createInternationalStandingOrders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalStandingOrdersApi.createInternationalStandingOrders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: PSUOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalStandingOrdersApi();
$body = ; // OBWriteInternationalStandingOrder4 | Default
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xIdempotencyKey = xIdempotencyKey_example; // String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

$xJwsSignature = xJwsSignature_example; // String | A detached JWS signature of the body of the payload.
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->createInternationalStandingOrders($body, $authorization, $xIdempotencyKey, $xJwsSignature, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalStandingOrdersApi;

# Configure OAuth2 access token for authorization: PSUOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalStandingOrdersApi->new();
my $body = WWW::SwaggerClient::Object::OBWriteInternationalStandingOrder4->new(); # OBWriteInternationalStandingOrder4 | Default
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xIdempotencyKey = xIdempotencyKey_example; # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

my $xJwsSignature = xJwsSignature_example; # String | A detached JWS signature of the body of the payload.
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->createInternationalStandingOrders(body => $body, authorization => $authorization, xIdempotencyKey => $xIdempotencyKey, xJwsSignature => $xJwsSignature, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrders: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: PSUOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalStandingOrdersApi()
body =  # OBWriteInternationalStandingOrder4 | Default
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xIdempotencyKey = xIdempotencyKey_example # String | Every request will be processed only once per x-idempotency-key.  The
Idempotency Key will be valid for 24 hours.

xJwsSignature = xJwsSignature_example # String | A detached JWS signature of the body of the payload.
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Create International Standing Orders
    api_response = api_instance.create_international_standing_orders(body, authorization, xIdempotencyKey, xJwsSignature, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalStandingOrdersApi->createInternationalStandingOrders: %s\n" % e)

Parameters

Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-idempotency-key*
String
Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.
Required
x-jws-signature*
String
A detached JWS signature of the body of the payload.
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.
Body parameters
Name Description
body *

Responses

Status: 201 - International Standing Orders Created

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 415 - Unsupported Media Type

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalStandingOrderConsentsConsentId

Get International Standing Order Consents


/international-standing-order-consents/{ConsentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-standing-order-consents/{ConsentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalStandingOrdersApi;

import java.io.File;
import java.util.*;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalStandingOrderConsentResponse7 result = apiInstance.getInternationalStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#getInternationalStandingOrderConsentsConsentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalStandingOrdersApi;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        String consentId = consentId_example; // String | ConsentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalStandingOrderConsentResponse7 result = apiInstance.getInternationalStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#getInternationalStandingOrderConsentsConsentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *consentId = consentId_example; // ConsentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalStandingOrdersApi *apiInstance = [[InternationalStandingOrdersApi alloc] init];

// Get International Standing Order Consents
[apiInstance getInternationalStandingOrderConsentsConsentIdWith:consentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalStandingOrderConsentResponse7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalStandingOrdersApi()
var consentId = consentId_example; // {{String}} ConsentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalStandingOrderConsentsConsentId(consentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalStandingOrderConsentsConsentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalStandingOrdersApi();
            var consentId = consentId_example;  // String | ConsentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get International Standing Order Consents
                OBWriteInternationalStandingOrderConsentResponse7 result = apiInstance.getInternationalStandingOrderConsentsConsentId(consentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalStandingOrdersApi.getInternationalStandingOrderConsentsConsentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalStandingOrdersApi();
$consentId = consentId_example; // String | ConsentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalStandingOrderConsentsConsentId($consentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrderConsentsConsentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalStandingOrdersApi->new();
my $consentId = consentId_example; # String | ConsentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalStandingOrderConsentsConsentId(consentId => $consentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrderConsentsConsentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalStandingOrdersApi()
consentId = consentId_example # String | ConsentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get International Standing Order Consents
    api_response = api_instance.get_international_standing_order_consents_consent_id(consentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrderConsentsConsentId: %s\n" % e)

Parameters

Path parameters
Name Description
ConsentId*
String
ConsentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - International Standing Order Consents Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalStandingOrdersInternationalStandingOrderPaymentId

Get International Standing Orders


/international-standing-orders/{InternationalStandingOrderPaymentId}

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-standing-orders/{InternationalStandingOrderPaymentId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InternationalStandingOrdersApi;

import java.io.File;
import java.util.*;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        String internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalStandingOrderResponse7 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#getInternationalStandingOrdersInternationalStandingOrderPaymentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.InternationalStandingOrdersApi;

public class InternationalStandingOrdersApiExample {

    public static void main(String[] args) {
        InternationalStandingOrdersApi apiInstance = new InternationalStandingOrdersApi();
        String internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWriteInternationalStandingOrderResponse7 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InternationalStandingOrdersApi#getInternationalStandingOrdersInternationalStandingOrderPaymentId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // InternationalStandingOrderPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

InternationalStandingOrdersApi *apiInstance = [[InternationalStandingOrdersApi alloc] init];

// Get International Standing Orders
[apiInstance getInternationalStandingOrdersInternationalStandingOrderPaymentIdWith:internationalStandingOrderPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWriteInternationalStandingOrderResponse7 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.InternationalStandingOrdersApi()
var internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // {{String}} InternationalStandingOrderPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalStandingOrdersInternationalStandingOrderPaymentIdExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new InternationalStandingOrdersApi();
            var internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example;  // String | InternationalStandingOrderPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get International Standing Orders
                OBWriteInternationalStandingOrderResponse7 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InternationalStandingOrdersApi.getInternationalStandingOrdersInternationalStandingOrderPaymentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiInternationalStandingOrdersApi();
$internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalStandingOrdersInternationalStandingOrderPaymentId($internationalStandingOrderPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrdersInternationalStandingOrderPaymentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InternationalStandingOrdersApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::InternationalStandingOrdersApi->new();
my $internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; # String | InternationalStandingOrderPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalStandingOrdersInternationalStandingOrderPaymentId(internationalStandingOrderPaymentId => $internationalStandingOrderPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrdersInternationalStandingOrderPaymentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.InternationalStandingOrdersApi()
internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example # String | InternationalStandingOrderPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get International Standing Orders
    api_response = api_instance.get_international_standing_orders_international_standing_order_payment_id(internationalStandingOrderPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InternationalStandingOrdersApi->getInternationalStandingOrdersInternationalStandingOrderPaymentId: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalStandingOrderPaymentId*
String
InternationalStandingOrderPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - International Standing Orders Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

PaymentDetails

getDomesticPaymentsDomesticPaymentIdPaymentDetails

Get Payment Details


/domestic-payments/{DomesticPaymentId}/payment-details

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-payments/{DomesticPaymentId}/payment-details"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticPaymentsDomesticPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticPaymentsDomesticPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *domesticPaymentId = domesticPaymentId_example; // DomesticPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getDomesticPaymentsDomesticPaymentIdPaymentDetailsWith:domesticPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.PaymentDetailsApi()
var domesticPaymentId = domesticPaymentId_example; // {{String}} DomesticPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticPaymentsDomesticPaymentIdPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var domesticPaymentId = domesticPaymentId_example;  // String | DomesticPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getDomesticPaymentsDomesticPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$domesticPaymentId = domesticPaymentId_example; // String | DomesticPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticPaymentsDomesticPaymentIdPaymentDetails($domesticPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getDomesticPaymentsDomesticPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $domesticPaymentId = domesticPaymentId_example; # String | DomesticPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticPaymentsDomesticPaymentIdPaymentDetails(domesticPaymentId => $domesticPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getDomesticPaymentsDomesticPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
domesticPaymentId = domesticPaymentId_example # String | DomesticPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_domestic_payments_domestic_payment_id_payment_details(domesticPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getDomesticPaymentsDomesticPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticPaymentId*
String
DomesticPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails

Get Payment Details


/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *domesticScheduledPaymentId = domesticScheduledPaymentId_example; // DomesticScheduledPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetailsWith:domesticScheduledPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.PaymentDetailsApi()
var domesticScheduledPaymentId = domesticScheduledPaymentId_example; // {{String}} DomesticScheduledPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var domesticScheduledPaymentId = domesticScheduledPaymentId_example;  // String | DomesticScheduledPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$domesticScheduledPaymentId = domesticScheduledPaymentId_example; // String | DomesticScheduledPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails($domesticScheduledPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $domesticScheduledPaymentId = domesticScheduledPaymentId_example; # String | DomesticScheduledPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails(domesticScheduledPaymentId => $domesticScheduledPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
domesticScheduledPaymentId = domesticScheduledPaymentId_example # String | DomesticScheduledPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_domestic_scheduled_payments_domestic_scheduled_payment_id_payment_details(domesticScheduledPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticScheduledPaymentId*
String
DomesticScheduledPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails

Get Payment Details


/domestic-standing-orders/{DomesticStandingOrderId}/payment-details

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/domestic-standing-orders/{DomesticStandingOrderId}/payment-details"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *domesticStandingOrderId = domesticStandingOrderId_example; // DomesticStandingOrderId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetailsWith:domesticStandingOrderId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.PaymentDetailsApi()
var domesticStandingOrderId = domesticStandingOrderId_example; // {{String}} DomesticStandingOrderId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var domesticStandingOrderId = domesticStandingOrderId_example;  // String | DomesticStandingOrderId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$domesticStandingOrderId = domesticStandingOrderId_example; // String | DomesticStandingOrderId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails($domesticStandingOrderId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $domesticStandingOrderId = domesticStandingOrderId_example; # String | DomesticStandingOrderId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails(domesticStandingOrderId => $domesticStandingOrderId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
domesticStandingOrderId = domesticStandingOrderId_example # String | DomesticStandingOrderId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_domestic_standing_orders_domestic_standing_order_id_payment_details(domesticStandingOrderId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
DomesticStandingOrderId*
String
DomesticStandingOrderId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getFilePaymentsFilePaymentIdPaymentDetails

Get Payment Details


/file-payments/{FilePaymentId}/payment-details

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/file-payments/{FilePaymentId}/payment-details"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getFilePaymentsFilePaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String filePaymentId = filePaymentId_example; // String | FilePaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getFilePaymentsFilePaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *filePaymentId = filePaymentId_example; // FilePaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getFilePaymentsFilePaymentIdPaymentDetailsWith:filePaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.PaymentDetailsApi()
var filePaymentId = filePaymentId_example; // {{String}} FilePaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFilePaymentsFilePaymentIdPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var filePaymentId = filePaymentId_example;  // String | FilePaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getFilePaymentsFilePaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$filePaymentId = filePaymentId_example; // String | FilePaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getFilePaymentsFilePaymentIdPaymentDetails($filePaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getFilePaymentsFilePaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $filePaymentId = filePaymentId_example; # String | FilePaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getFilePaymentsFilePaymentIdPaymentDetails(filePaymentId => $filePaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getFilePaymentsFilePaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
filePaymentId = filePaymentId_example # String | FilePaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_file_payments_file_payment_id_payment_details(filePaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getFilePaymentsFilePaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
FilePaymentId*
String
FilePaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalPaymentsInternationalPaymentIdPaymentDetails

Get Payment Details


/international-payments/{InternationalPaymentId}/payment-details

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-payments/{InternationalPaymentId}/payment-details"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalPaymentsInternationalPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalPaymentsInternationalPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *internationalPaymentId = internationalPaymentId_example; // InternationalPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getInternationalPaymentsInternationalPaymentIdPaymentDetailsWith:internationalPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.PaymentDetailsApi()
var internationalPaymentId = internationalPaymentId_example; // {{String}} InternationalPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalPaymentsInternationalPaymentIdPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var internationalPaymentId = internationalPaymentId_example;  // String | InternationalPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getInternationalPaymentsInternationalPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$internationalPaymentId = internationalPaymentId_example; // String | InternationalPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalPaymentsInternationalPaymentIdPaymentDetails($internationalPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getInternationalPaymentsInternationalPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $internationalPaymentId = internationalPaymentId_example; # String | InternationalPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalPaymentsInternationalPaymentIdPaymentDetails(internationalPaymentId => $internationalPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getInternationalPaymentsInternationalPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
internationalPaymentId = internationalPaymentId_example # String | InternationalPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_international_payments_international_payment_id_payment_details(internationalPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getInternationalPaymentsInternationalPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalPaymentId*
String
InternationalPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails

Get Payment Details


/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *internationalScheduledPaymentId = internationalScheduledPaymentId_example; // InternationalScheduledPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsWith:internationalScheduledPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.PaymentDetailsApi()
var internationalScheduledPaymentId = internationalScheduledPaymentId_example; // {{String}} InternationalScheduledPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var internationalScheduledPaymentId = internationalScheduledPaymentId_example;  // String | InternationalScheduledPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$internationalScheduledPaymentId = internationalScheduledPaymentId_example; // String | InternationalScheduledPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails($internationalScheduledPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $internationalScheduledPaymentId = internationalScheduledPaymentId_example; # String | InternationalScheduledPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails(internationalScheduledPaymentId => $internationalScheduledPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
internationalScheduledPaymentId = internationalScheduledPaymentId_example # String | InternationalScheduledPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_international_scheduled_payments_international_scheduled_payment_id_payment_details(internationalScheduledPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalScheduledPaymentId*
String
InternationalScheduledPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails

Get Payment Details


/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details

Usage and SDK Samples

curl -X GET\
\
\
-H "Accept: application/json; charset=utf-8,application/json,application/jose+jwe"\
"https://api.ob.alrayanbank.co.uk/pisp/v3.1/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PaymentDetailsApi;

import java.io.File;
import java.util.*;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure OAuth2 access token for authorization: TPPOAuth2Security
        OAuth TPPOAuth2Security = (OAuth) defaultClient.getAuthentication("TPPOAuth2Security");
        TPPOAuth2Security.setAccessToken("YOUR ACCESS TOKEN");

        // Configure OAuth2 access token for authorization: default
        OAuth default = (OAuth) defaultClient.getAuthentication("default");
        default.setAccessToken("YOUR ACCESS TOKEN");

        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PaymentDetailsApi;

public class PaymentDetailsApiExample {

    public static void main(String[] args) {
        PaymentDetailsApi apiInstance = new PaymentDetailsApi();
        String internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
        String authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
        String xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
        String xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
        String xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
        String xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.
        try {
            OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentDetailsApi#getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure OAuth2 access token for authorization: (authentication scheme: TPPOAuth2Security)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
// Configure OAuth2 access token for authorization: (authentication scheme: default)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];
String *internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // InternationalStandingOrderPaymentId
String *authorization = authorization_example; // An Authorisation Token as per https://tools.ietf.org/html/rfc6750
String *xFapiAuthDate = xFapiAuthDate_example; // The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
String *xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
String *xFapiInteractionId = xFapiInteractionId_example; // An RFC4122 UID used as a correlation id. (optional)
String *xCustomerUserAgent = xCustomerUserAgent_example; // Indicates the user-agent that the PSU is using. (optional)

PaymentDetailsApi *apiInstance = [[PaymentDetailsApi alloc] init];

// Get Payment Details
[apiInstance getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetailsWith:internationalStandingOrderPaymentId
    authorization:authorization
    xFapiAuthDate:xFapiAuthDate
    xFapiCustomerIpAddress:xFapiCustomerIpAddress
    xFapiInteractionId:xFapiInteractionId
    xCustomerUserAgent:xCustomerUserAgent
              completionHandler: ^(OBWritePaymentDetailsResponse1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var PaymentInitiationApi = require('payment_initiation_api');
var defaultClient = PaymentInitiationApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: TPPOAuth2Security
var TPPOAuth2Security = defaultClient.authentications['TPPOAuth2Security'];
TPPOAuth2Security.accessToken = "YOUR ACCESS TOKEN"

// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new PaymentInitiationApi.PaymentDetailsApi()
var internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // {{String}} InternationalStandingOrderPaymentId
var authorization = authorization_example; // {{String}} An Authorisation Token as per https://tools.ietf.org/html/rfc6750
var opts = { 
  'xFapiAuthDate': xFapiAuthDate_example, // {{String}} The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
  'xFapiCustomerIpAddress': xFapiCustomerIpAddress_example, // {{String}} The PSU's IP address if the PSU is currently logged in with the TPP.
  'xFapiInteractionId': xFapiInteractionId_example, // {{String}} An RFC4122 UID used as a correlation id.
  'xCustomerUserAgent': xCustomerUserAgent_example // {{String}} Indicates the user-agent that the PSU is using.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId, authorization, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetailsExample
    {
        public void main()
        {

            // Configure OAuth2 access token for authorization: TPPOAuth2Security
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            // Configure OAuth2 access token for authorization: default
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new PaymentDetailsApi();
            var internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example;  // String | InternationalStandingOrderPaymentId
            var authorization = authorization_example;  // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
            var xFapiAuthDate = xFapiAuthDate_example;  // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional) 
            var xFapiCustomerIpAddress = xFapiCustomerIpAddress_example;  // String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional) 
            var xFapiInteractionId = xFapiInteractionId_example;  // String | An RFC4122 UID used as a correlation id. (optional) 
            var xCustomerUserAgent = xCustomerUserAgent_example;  // String | Indicates the user-agent that the PSU is using. (optional) 

            try
            {
                // Get Payment Details
                OBWritePaymentDetailsResponse1 result = apiInstance.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId, authorization, xFapiAuthDate, xFapiCustomerIpAddress, xFapiInteractionId, xCustomerUserAgent);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PaymentDetailsApi.getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: TPPOAuth2Security
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: default
Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\ApiPaymentDetailsApi();
$internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; // String | InternationalStandingOrderPaymentId
$authorization = authorization_example; // String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
$xFapiAuthDate = xFapiAuthDate_example; // String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
$xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; // String | The PSU's IP address if the PSU is currently logged in with the TPP.
$xFapiInteractionId = xFapiInteractionId_example; // String | An RFC4122 UID used as a correlation id.
$xCustomerUserAgent = xCustomerUserAgent_example; // String | Indicates the user-agent that the PSU is using.

try {
    $result = $api_instance->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails($internationalStandingOrderPaymentId, $authorization, $xFapiAuthDate, $xFapiCustomerIpAddress, $xFapiInteractionId, $xCustomerUserAgent);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentDetailsApi->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PaymentDetailsApi;

# Configure OAuth2 access token for authorization: TPPOAuth2Security
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
# Configure OAuth2 access token for authorization: default
$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = WWW::SwaggerClient::PaymentDetailsApi->new();
my $internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example; # String | InternationalStandingOrderPaymentId
my $authorization = authorization_example; # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
my $xFapiAuthDate = xFapiAuthDate_example; # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC
my $xFapiCustomerIpAddress = xFapiCustomerIpAddress_example; # String | The PSU's IP address if the PSU is currently logged in with the TPP.
my $xFapiInteractionId = xFapiInteractionId_example; # String | An RFC4122 UID used as a correlation id.
my $xCustomerUserAgent = xCustomerUserAgent_example; # String | Indicates the user-agent that the PSU is using.

eval { 
    my $result = $api_instance->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails(internationalStandingOrderPaymentId => $internationalStandingOrderPaymentId, authorization => $authorization, xFapiAuthDate => $xFapiAuthDate, xFapiCustomerIpAddress => $xFapiCustomerIpAddress, xFapiInteractionId => $xFapiInteractionId, xCustomerUserAgent => $xCustomerUserAgent);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentDetailsApi->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: TPPOAuth2Security
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'
# Configure OAuth2 access token for authorization: default
swagger_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = swagger_client.PaymentDetailsApi()
internationalStandingOrderPaymentId = internationalStandingOrderPaymentId_example # String | InternationalStandingOrderPaymentId
authorization = authorization_example # String | An Authorisation Token as per https://tools.ietf.org/html/rfc6750
xFapiAuthDate = xFapiAuthDate_example # String | The time when the PSU last logged in with the TPP. 
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: 
Sun, 10 Sep 2017 19:43:31 UTC (optional)
xFapiCustomerIpAddress = xFapiCustomerIpAddress_example # String | The PSU's IP address if the PSU is currently logged in with the TPP. (optional)
xFapiInteractionId = xFapiInteractionId_example # String | An RFC4122 UID used as a correlation id. (optional)
xCustomerUserAgent = xCustomerUserAgent_example # String | Indicates the user-agent that the PSU is using. (optional)

try: 
    # Get Payment Details
    api_response = api_instance.get_international_standing_orders_international_standing_order_payment_id_payment_details(internationalStandingOrderPaymentId, authorization, xFapiAuthDate=xFapiAuthDate, xFapiCustomerIpAddress=xFapiCustomerIpAddress, xFapiInteractionId=xFapiInteractionId, xCustomerUserAgent=xCustomerUserAgent)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentDetailsApi->getInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails: %s\n" % e)

Parameters

Path parameters
Name Description
InternationalStandingOrderPaymentId*
String
InternationalStandingOrderPaymentId
Required
Header parameters
Name Description
x-fapi-auth-date
String
The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
String
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
String
An RFC4122 UID used as a correlation id.
Authorization*
String
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Required
x-customer-user-agent
String
Indicates the user-agent that the PSU is using.

Responses

Status: 200 - Payment Details Read

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 400 - Bad request

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 401 - Unauthorized

Name Type Format Description
x-fapi-interaction-id String

Status: 403 - Forbidden

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String

Status: 404 - Not found

Name Type Format Description
x-fapi-interaction-id String

Status: 405 - Method Not Allowed

Name Type Format Description
x-fapi-interaction-id String

Status: 406 - Not Acceptable

Name Type Format Description
x-fapi-interaction-id String

Status: 429 - Too Many Requests

Name Type Format Description
Retry-After Integer
x-fapi-interaction-id String

Status: 500 - Internal Server Error

Name Type Format Description
x-fapi-interaction-id String
x-jws-signature String